Skip to content

Add new WINE.md help file#923

Draft
marc-hb wants to merge 1 commit intozephyrproject-rtos:mainfrom
marc-hb:WINE
Draft

Add new WINE.md help file#923
marc-hb wants to merge 1 commit intozephyrproject-rtos:mainfrom
marc-hb:WINE

Conversation

@marc-hb
Copy link
Copy Markdown
Collaborator

@marc-hb marc-hb commented Feb 20, 2026

Slow and not 100% reliable but still very useful to quickly test Pathlib and other issues without juggling with multiple systems.

This helped me a lot with #928

cc:

@marc-hb marc-hb marked this pull request as ready for review February 20, 2026 21:23
@marc-hb marc-hb requested a review from mbolivar February 20, 2026 21:23
@marc-hb
Copy link
Copy Markdown
Collaborator Author

marc-hb commented Feb 20, 2026

I tried uv but it's not necessary now and it fails like this:

cd west
rm -rf .venv # do not share `uv` with WINE
wenv uv version # OK
wenv uv format # OK
wenv uv run poe # FAIL

   Building docopt==0.6.2
  × Failed to build `west @ file:///Z:/home/marc/west`
  ├─▶ The build backend returned an error
  ╰─▶ Call to `setuptools.build_meta.build_editable` failed (exit code: 1)

      [stderr]
      Fatal Python error: Failed to import encodings module
      Python runtime state: core initialized
      ImportError: bad magic number in 'encodings': b'\xcb\r\r\n'

      Current thread 0x0000015c (most recent call first):
        <no Python frame>

      hint: This usually indicates a problem with the package or the build environment.

wenv pip -v install encodings

ERROR: Could not find a version that satisfies the requirement encodings (from versions: none)
ERROR: No matching distribution found for encodings

wenv python -c 'import encodings; print(encodings)'
<module 'encodings' from 'Z:\\tmp\\wenv-d574c107\\Lib\\encodings\\__init__.pyc'>

@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.95%. Comparing base (2d883de) to head (76ef07d).
⚠️ Report is 9 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #923      +/-   ##
==========================================
- Coverage   86.01%   85.95%   -0.06%     
==========================================
  Files          11       11              
  Lines        3453     3460       +7     
==========================================
+ Hits         2970     2974       +4     
- Misses        483      486       +3     

see 2 files with indirect coverage changes

Copy link
Copy Markdown
Collaborator

@pdgendt pdgendt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hate to whine about this (pun intended), but do we need a "quick and dirty recipe" for something that clearly isn't well supported?

@marc-hb
Copy link
Copy Markdown
Collaborator Author

marc-hb commented Feb 23, 2026

Good question!

  • Because many people would not be aware this possibility even exists. See this new file as a (quiet) "advertisement" in a corner.
  • Because (other) Un*x users suspecting the possibility might exist would likely waste a couple hours of trial and error exactly like I did before finding and aligning the planets as indicated in this new, small text file. Or, more likely, they would give up after less than 30 min and fetch and dust off some Windows system from their attic instead[*]. I didn't give up because I didn't have access to Windows - necessity is the mother of invention!
  • Even when this doc gets out of date, it will still be a much better starting point than nothing at all.

[*] ... and then they would watch that Windows system downloading and applying updates for hours and hours, but at least they could do something on their main, Linux system in the meantime. I digress.

@kartben
Copy link
Copy Markdown
Member

kartben commented Feb 23, 2026

It looks to me as if this should just be a wiki page maybe?

@marc-hb
Copy link
Copy Markdown
Collaborator Author

marc-hb commented Feb 23, 2026

That definitely looks like wiki material! On the other hand, starting a new west wiki just for this page feels overkill and that page would feel alone and likely not seen much. Now you have to start somewhere and a first page is by definition alone for some time - but I'm afraid that one would be alone for a very long time in a "west wiki".

Also, wikis tend to be for users and especially new users whereas this is 100% a development trick.

I could move it (and the MAINTAINERS.rst file) to a new doc/ subdirectory to reduce distraction?

@marc-hb marc-hb force-pushed the WINE branch 3 times, most recently from 0898bf5 to 9b0fd47 Compare February 26, 2026 20:03
@nmunnich
Copy link
Copy Markdown

As someone more on the periphery of west, I'd support a new doc/ subdirectory. I'd suggest that the "hacking on west" section of the readme get its own file in that case, and link to said file from the main readme.

@pdgendt
Copy link
Copy Markdown
Collaborator

pdgendt commented Feb 27, 2026

As someone more on the periphery of west, I'd support a new doc/ subdirectory. I'd suggest that the "hacking on west" section of the readme get its own file in that case, and link to said file from the main readme.

I need to get back to #860, where this might be moved to.

Slow and not 100% reliable but still very useful to quickly test
Pathlib and other issues without juggling with multiple systems.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants